Original Note

1.5 Python Code Style Conventions - Outline

Outline

  1. 1.5 Python Code Style Conventions(整理版)
  2. 内容简要概括
  3. 目录
  4. 1. PEP 8 与缩进
  5. 悬挂缩进
  6. 函数定义
  7. 2. 行宽与表达式换行
  8. 最大行宽
  9. 二元运算符的位置
  10. 3. 空行
  11. 顶层函数和类之间空两行
  12. 类中的方法之间空一行
  13. 函数内部少量使用空行
  14. 装饰器与定义之间不要空行
  15. 4. 空格
  16. 括号内部不加无意义空格
  17. 逗号、分号和冒号前不留空格
  18. 切片中的冒号
  19. 二元运算符
  20. 普通赋值中的 `=`
  21. 关键字参数中的 `=`
  22. 默认参数中的 `=`
  23. 5. 命名规范
  24. 变量:snake_case
  25. 函数和方法:snake_case
  26. 类:PascalCase
  27. 模块:简短、全小写
  28. 包:简短、全小写
  29. 命名速查
  30. 6. 注释
  31. Block comment:块注释
  32. Inline comment:行内注释
  33. 7. Docstring